Get Notification by ID

GET 
/notifications/:id

Retrieve the information of the notification with the matching ID.

Request

Path Parameters

id uuidrequired

ID of the notification

Header Parameters

x-api-key stringrequired

base64 encoded store ID

Responses

200

Notification Found

application/json

Schema

Schema

status stringrequired

Possible values: [pending, failed, complete]

Default value: pending

Status of the given notification.

payload object

Optional payload.

Example (from schema)

{
  "status": "pending",
  "payload": {}
}

Example 1

{
  "status": "pending",
  "payload": {
    "example": "Hello World!"
  }
}

400

Bad request

application/json

Schema

Schema

title string

A short summary of the problem type.

detail string

A human-readable explanation specific to this occurrence of the problem

status number

The HTTP status code generated by the origin server for this occurrence of the problem.

Example (from schema)

{
  "title": "string",
  "detail": "string",
  "status": 0
}

401

Unauthorized

500

Bad request

application/json

Schema

Schema

title string

A short summary of the problem type.

detail string

A human-readable explanation specific to this occurrence of the problem

status number

The HTTP status code generated by the origin server for this occurrence of the problem.

Example (from schema)

{
  "title": "string",
  "detail": "string",
  "status": 0
}

Loading...